Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Nov 5, 2025

Add Mintlify integration documentation

Summary

Added a concise documentation page explaining how to integrate Fern-generated SDKs with Mintlify documentation sites. The integration works by referencing Fern's OpenAPI spec (enriched with SDK code samples) in Mintlify's docs.json configuration.

Changes:

  • Created Mintlify integration page at fern/products/docs/pages/integrations/mintlify.mdx (28 lines)
  • Added navigation entry in the "Analytics & integrations" section
  • Added Mintlify card to the integrations overview page
  • Content kept minimal per feedback: "generate SDKs with Fern → document with Mintlify"

Review & Testing Checklist for Human

  • ⚠️ CRITICAL: OpenAPI registry URL doesn't exist yet - The page documents https://registry.buildwithfern.com/{org}/{api-name}/openapi/openapi.json but this infrastructure hasn't been implemented. Should this PR be merged before or after the registry is live? If merged now, users following these instructions will get 404 errors.
  • Verify page renders correctly - Navigate to /learn/docs/integrations/mintlify and check formatting, code blocks, and that it matches the concise style requested
  • Test navigation and card - Verify the Mintlify card appears in /learn/docs/integrations/overview and clicking it navigates to the correct page
  • Check content completeness - Is the 28-line page sufficient, or does it need more detail about finding org/api-name values, prerequisites on the Fern side, or what the enriched code samples look like?

Test Plan

  1. Preview the page at the preview URL and navigate to the Mintlify integration page
  2. Click through from the integrations overview card
  3. Verify the code sample renders correctly
  4. (Cannot test) Actually using the documented URL will fail until registry infrastructure exists

Notes

  • Pattern inspired by Speakeasy and Stainless integration pages
  • Content was intentionally kept very concise per @dannysheridan's feedback: "be concise and dry" and "generate SDKs with Fern → document with Mintlify"
  • File placement went through iterations based on feedback:
    • Initially integrations/sdks/fern.mdx → renamed to mintlify.mdx
    • Moved to integrations/docs/mintlify.mdx → moved to integrations/mintlify.mdx (no subdirectory)
    • Custom slug and redirects were added then removed per PR comments
  • There was discussion about productizing the OpenAPI registry with S3/CloudFront, but that implementation was explicitly deferred
  • Created by @dannysheridan's request in Slack thread
  • Devin session

- Create new integration page at fern/products/docs/pages/integrations/sdks/fern.mdx
- Add navigation entry in docs.yml
- Add Fern card to integrations overview page
- Follow pattern from Speakeasy and Stainless integration pages

Co-Authored-By: [email protected] <[email protected]>
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

}
```

Fern-generated code snippets can now be viewed in your API docs and interacted with in the playground.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated

@github-actions
Copy link
Contributor

github-actions bot commented Nov 5, 2025

@github-actions
Copy link
Contributor

github-actions bot commented Nov 5, 2025

- Rename file from fern.mdx to mintlify.mdx
- Update page title to 'Mintlify'
- Update navigation entry in docs.yml
- Update overview page card with Mintlify branding
- Update slug from sdks/fern to sdks/mintlify

Co-Authored-By: [email protected] <[email protected]>
@github-actions
Copy link
Contributor

github-actions bot commented Nov 5, 2025

- Move mintlify.mdx from integrations/sdks/ to integrations/docs/
- Update content to be concise: generate SDKs with Fern → document with Mintlify
- Update navigation in docs.yml to point to new docs/ location
- Update overview page card href to new docs/ location
- Add redirect from old /sdks/mintlify path to new /docs/mintlify path

Co-Authored-By: [email protected] <[email protected]>
@github-actions
Copy link
Contributor

github-actions bot commented Nov 5, 2025

fern/docs.yml Outdated
destination: /learn/docs/getting-started/project-structure
- source: /learn/docs/alternatives/mintlify
destination: /learn/docs/getting-started/overview
- source: /learn/docs/integrations/sdks/mintlify
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

undo this change

path: ./pages/integrations/postman.mdx
- page: Mintlify
path: ./pages/integrations/docs/mintlify.mdx
slug: docs/mintlify
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove slug

- Remove slug: docs/mintlify from navigation
- Remove redirect from /integrations/sdks/mintlify to /integrations/docs/mintlify

Co-Authored-By: [email protected] <[email protected]>
@github-actions
Copy link
Contributor

github-actions bot commented Nov 5, 2025

- page: Postman
path: ./pages/integrations/postman.mdx
- page: Mintlify
path: ./pages/integrations/docs/mintlify.mdx
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Get rid of /docs here


<Card
title="Mintlify"
href="/docs/integrations/docs/mintlify"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No /docs

- Move mintlify.mdx from integrations/docs/ to integrations/
- Update navigation path in docs.yml
- Update overview card href from /docs/integrations/docs/mintlify to /docs/integrations/mintlify

Co-Authored-By: [email protected] <[email protected]>
@github-actions
Copy link
Contributor

github-actions bot commented Nov 5, 2025

@dannysheridan dannysheridan merged commit f3d75b2 into main Nov 5, 2025
2 checks passed
@dannysheridan dannysheridan deleted the devin/1762352751-mintlify-fern-integration branch November 5, 2025 20:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants